GetOverwrite {Steel AS 4100-2020}

GetOverwrite

Syntax

SapObject.SapModel.DesignSteel.Australian_AS4100_2020.GetOverwrite

VB6 Procedure

Function GetOverwrite(ByVal Name As String, ByVal Item 
 As Long, ByRef Value As Double, ByRef ProgDet As Boolean) As Long

Parameters

Name

The name of a frame object with a steel frame design 
 procedure.

Item

This is an integer between 1 and 46, inclusive, indicating 
 the overwrite item considered.

1 = Framing type

2 = Steel type

3 = Consider deflection

4 = Deflection check type

5 = DL deflection limit, 
 L/Value

6 = SDL + LL deflection 
 limit, L/Value

7 = LL deflection limit, 
 L/Value

8 = Total load deflection 
 limit, L/Value

9 = Total camber limit, 
 L/Value

10 = DL deflection limit, 
 absolute

11 = SDL + LL deflection 
 limit, absolute

12 = LL deflection limit, 
 absolute

13 = Total load deflection 
 limit, absolute

14 = Total camber limit, 
 absolute

15 = Specified camber

16 = Net area to total 
 area ratio

17 = Live load reduction 
 factor

18 = Unbraced length ratio, 
 Major

19 = Unbraced length ratio, 
 Minor

20 = Unbraced length ratio, 
 Lateral Torsional Buckling

21 = Effective length 
 factor, Ke Major Braced

22 = Effective length 
 factor, Ke Minor Braced

23 = Effective length 
 factor, Ke Major Sway

24 = Effective length 
 factor, Ke Minor Sway

25 = Twist restraint factor 
 for LTB (kt)

26 = lateral rotation 
 restraint factor (kr)

27 = Load height factor 
 for LTB (kl)

28 = Moment coefficient, 
 Cm Major

29 = Moment coefficient, 
 Cm Minor

30 = Moment modification 
 factor, Alpha_m

31 = Slender reduction 
 factor, Alpha_s

32 = Nonsway moment factor, 
 Db Major

33 = Nonsway moment factor, 
 Db Minor

34 = Sway moment factor, 
 Ds Major

35 = Sway moment factor, 
 Ds Minor

36 = Form factor, Kf

37 = Axial capacity correction 
 factor, Kt

38 = Yield stress, Fy

39 = Compressive capacity, 
 Nc

40 = Tensile capacity, 
 Nt

41 = Major bending capacity, 
 Ms33

42 = Minor bending capacity, 
 Ms22

43 = Major bending capacity, 
 Mb33

44 = Major shear capacity, 
 Vu2

45 = Minor shear capacity, 
 Vu3

46 = Demand/capacity ratio 
 limit

Value

The value of the considered overwrite item.

1 = Framing type

0 = As specified in preferences

1 = Moment frame

2 = Braced frame

2 = Steel type

1 = Hot rolled

2 = Hot finished

3 = Cold form

4 = Stress relieved

5 = Lightly welded

6 = Heavily welded

3 = Consider deflection

0 = No

Any other value = Yes

4 = Deflection check type

0 = Program default

1 = Ratio

2 = Absolute

3 = Both

5 = DL deflection limit, 
 L/Value

Value >= 0; 0 means 
 no check for this item.

6 = SDL + LL deflection 
 limit, L/Value

Value >= 0; 0 means 
 no check for this item.

7 = LL deflection limit, 
 L/Value

Value >= 0; 0 means 
 no check for this item.

8 = Total load deflection 
 limit, L/Value

Value >= 0; 0 means 
 no check for this item.

9 = Total camber limit, 
 L/Value

Value >= 0; 0 means 
 no check for this item.

10 = DL deflection limit, 
 absolute

Value >= 
 0; 0 means no check for this item. [L]

11 = SDL + LL deflection 
 limit, absolute

Value >= 
 0; 0 means no check for this item. [L]

12 = LL deflection limit, 
 absolute

Value >= 
 0; 0 means no check for this item. [L]

13 = Total load deflection 
 limit, absolute

Value >= 
 0; 0 means no check for this item. [L]}

14 = Total camber limit, 
 absolute

Value >= 
 0; 0 means no check for this item. [L]

15 = Specified camber

Value >= 
 0. [L}

16 = Net area to total 
 area ratio

Value >= 
 0; 0 means use program default value.

17 = Live load reduction 
 factor

Value >= 
 0; 0 means use program determined value.

18 = Unbraced length ratio, 
 Major

Value >= 
 0; 0 means use program determined value.

19 = Unbraced length ratio, 
 Minor

Value >= 
 0; 0 means use program determined value.

20 = Unbraced length ratio, 
 Lateral Torsional Buckling

Value >= 
 0; 0 means use program determined value.

21 = Effective length 
 factor, Ke Major Braced

Value >= 
 0; 0 means use program determined value.

22 = Effective length 
 factor, Ke Minor Braced

Value >= 
 0; 0 means use program determined value.

23 = Effective length 
 factor, Ke Major Sway

Value >= 
 0; 0 means use program determined value.

24 = Effective length 
 factor, Ke Minor Sway

Value >= 
 0; 0 means use program determined value.

25 = Twist restraint factor 
 for LTB (kt)

Value >= 
 0; 0 means use program determined value.

26 = Lateral rotation 
 restraint factor (kr)

Value >= 
 0; 0 means use program determined value.

27 = Load height factor 
 for LTB (kl)

Value >= 
 0; 0 means use program determined value.

28 = Moment coefficient, 
 Cm Major

Value >= 
 0; 0 means use program determined value.

29 = Moment coefficient, 
 Cm Minor

Value >= 
 0; 0 means use program determined value.

30 = Moment modification 
 factor, Alpha_m

Value >= 
 0; 0 means use program determined value.

31 = Slender reduction 
 factor, Alpha_s

Value >= 
 0; 0 means use program determined value.

32 = Nonsway moment factor, 
 Db Major

Value >= 
 0; 0 means use program determined value.

33 = Nonsway moment factor, 
 Db Minor

Value >= 
 0; 0 means use program determined value.

34 = Sway moment factor, 
 Bs Major

Value >= 
 0; 0 means use program determined value.

35 = Sway moment factor, 
 Bs Minor

Value >= 
 0; 0 means use program determined value.

36 = Form factor, Kf

Value >= 
 0; 0 means use program determined value.

37 = Axial capacity correction 
 factor, Kt

Value >= 
 0; 0 means use program determined value.

38 = Yield stress, Fy

Value >= 
 0; 0 means use program determined value. [F/L
2
]

39 = Compressive capacity, 
 Nc

Value >= 
 0; 0 means use program determined value. [F]

40 = Tensile capacity, 
 Nt

Value >= 
 0; 0 means use program determined value. [F]

41 = Major bending capacity, 
 Ms33

Value >= 
 0; 0 means use program determined value. [FL]

42 = Minor bending capacity, 
 Ms22

Value >= 
 0; 0 means use program determined value. [FL]

43 = Minor bending capacity, 
 Mb33

Value >= 
 0; 0 means use program determined value. [FL]

44 = Major shear capacity, 
 Vu2

Value >= 
 0; 0 means use program determined value. [F]

45 = Minor shear capacity, 
 Vu3

Value >= 
 0; 0 means use program determined value. [F]

46 = Demand/capacity ratio 
 limit

Value >= 
 0; 0 means use program determined value.

ProgDet

If this item is True then the specified value is program 
 determined.

Remarks

This function retrieves the value of a steel design 
 preference item.

The function returns zero if the item is successfully 
 retrieved, otherwise it returns a nonzero value.

VBA Example

Sub GetSteelDesignOverwriteItemAustralian_AS4100_2020()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim Value As Double

Dim ProgDet As B o o l e a n b r / > 
 b r / > 
 &# 3 9 ; c r e a t e S a p 2 0 0 0 o b j e c t b r / > 
 S e t S a p O b j e c t = C r e a t e O b j e c t ( &q u o t ; C S I . S A P 2 0 0 0 . A P I . S a p O b j e c t &q u o t ; ) b r / > 
 b r / > 
 &# 3 9 ; s t a r t S a p 2 0 0 0 a p p l i c a t i o n b r / > 
 S a p O b j e c t . A p p l i c a t i o n S t a r t b r / > 
 b r / > 
 &# 3 9 ; c r e a t e S a p M o d e l o b j e c t b r / > 
 S e t S a p M o d e l = S a p O b j e c t . S a p M o d e l b r / > 
 b r / > 
 &# 3 9 ; i n i t i a l i z e m o d e l b r / > 
 r e t = S a p M o d e l . I n i t i a l i z e N e w M o d e l b r / > 
 b r / > 
 &# 3 9 ; c r e a t e m o d e l f r o m t e m p l a t e b r / > 
 r e t = S a p M o d e l . F i l e . N e w 2 D F r a m e ( P o r t a l F r a m e , 
 2 , 1 4 4 , 2 , 2 8 8 ) b r / > 
 b r / > 
 &# 3 9 ; s e t s t e e l d e s i g n c o d e b r / > 
 r e t = S a p M o d e l . D e s i g n S t e e l . S e t C o d e ( &q u o t ; A S 
 4 1 0 0 - 2 0 2 0 &q u o t ; ) b r / > 
 b r / > 
 &# 3 9 ; r u n a n a l y s i s b r / > 
 r e t = S a p M o d e l . F i l e . S a v e ( &q u o t ; C : \ S a p A P I \ x . s d b &q u o t ; ) b r / > 
 r e t = S a p M o d e l . A n a l y z e . R u n A n a l y s i s b r / > 
 b r / > 
 &# 3 9 ; s t a r t s t e e l d e s i g n b r / > 
 r e t = S a p M o d e l . D e s i g n S t e e l . S t a r t D e s i g n b r / > 
 b r / > 
 &# 3 9 ; g e t o v e r w r i t e i t e m b r / > 
 r e t = S a p M o d e l . D e s i g n S t e e l . A u s t r a l i a n _ A S 4 1 0 0 _ 2 0 2 0 . G e t O v e r w r i t e ( &q u o t ; 8 &q u o t ; , 
 1 , V a l u e , P r o g D e t ) b r / > 
 b r / > 
 &# 3 9 ; c l o s e S a p 2 0 0 0 b r / > 
 S a p O b j e c t . A p p l i c a t i o n E x i t F a l s e b r / > 
 S e t S a p M o d e l = N o t h i n g b r / > 
 S e t S a p O b j e c t = N o t h i n g b r / > 
 E n d S u b / p > 
 h 2 > R e l e a s e N o t e s / h 2 > 
 p c l a s s = " C o m m e n t " > I n i t i a l r e l e a s e i n v e r s i o n 2 5 . 0 / p > 
 h 2 > S e e A l s o / h 2 > 
 p c l a s s = " C o m m e n t " > a h r e f = " S e t O v e r w r i t e _ { S t e e l _ A S _ 4 1 0 0 - 2 0 2 0 } . h t m " > S e t O v e r w r i t e / a > / p > 

 / b o d y > / h t m l >